CFrame Class Reference
[Container Views]

The CFrame is the parent container of all views. More...

Inheritance diagram for CFrame:
Inheritance graph
[legend]
Collaboration diagram for CFrame:
Collaboration graph
[legend]

List of all members.

Public Types

typedef std::list
< SharedPointer< CView >
>::const_iterator 
ChildViewConstIterator
typedef std::list
< SharedPointer< CView >
>::const_reverse_iterator 
ChildViewConstReverseIterator
Drag & Drop Methods



enum  DragResult { kDragRefused = 0, kDragMoved, kDragCopied, kDragError = -1 }

Public Member Functions

 VSTGUI_DEPRECATED (CFrame(const CRect &size, void *pSystemWindow, VSTGUIEditorInterface *pEditor);) CFrame(const CRect &size
void invalid ()
 mark whole view as invalid
void invalidRect (const CRect &rect)
 mark rect as invalid
IPlatformFrame * getPlatformFrame () const
bool removeView (CView *pView, bool withForget=true)
 remove a child view
bool removeAll (bool withForget=true)
 remove all child views
CViewgetViewAt (const CPoint &where, bool deep=false, bool mustbeMouseEnabled=false) const
 get the view at point where
CViewContainergetContainerAt (const CPoint &where, bool deep=true) const
 get the container at point where
virtual bool attached (CView *parent)
void draw (CDrawContext *pContext)
 called if the view should draw itself
void drawRect (CDrawContext *pContext, const CRect &updateRect)
 called if the view should draw itself
CMouseEventResult onMouseDown (CPoint &where, const CButtonState &buttons)
 called when a mouse down event occurs
CMouseEventResult onMouseUp (CPoint &where, const CButtonState &buttons)
 called when a mouse up event occurs
CMouseEventResult onMouseMoved (CPoint &where, const CButtonState &buttons)
 called when a mouse move event occurs
CMouseEventResult onMouseExited (CPoint &where, const CButtonState &buttons)
 called when the mouse leaves this view
bool onWheel (const CPoint &where, const float &distance, const CButtonState &buttons)
 called if a mouse wheel event is happening over this view
bool onWheel (const CPoint &where, const CMouseWheelAxis &axis, const float &distance, const CButtonState &buttons)
 called if a mouse wheel event is happening over this view
int32_t onKeyDown (VstKeyCode &keyCode)
 called if a key down event occurs and this view has focus
int32_t onKeyUp (VstKeyCode &keyCode)
 called if a key up event occurs and this view has focus
DragResult doDrag (IDataPackage *source, const CPoint &offset, CBitmap *dragBitmap)
 start a drag operation. See CDropSource to create the source data package
void setViewSize (const CRect &rect, bool invalid=true)
 set views size
virtual VSTGUIEditorInterfacegetEditor () const
 get editor
void modifyDrawContext (CCoord save[4], CDrawContext *pContext)
void restoreDrawContext (CDrawContext *pContext, CCoord save[4])
virtual bool invalidateDirtyViews ()
virtual CRect getVisibleSize (const CRect &rect) const
virtual CMouseEventResult onMouseCancel ()
 called when mouse tracking should be canceled
virtual bool hitTest (const CPoint &where, const CButtonState &buttons=-1)
 check if where hits this view
virtual CMessageResult notify (CBaseObject *sender, IdStringPtr message)
virtual void onTouchEvent (ITouchEvent &event)
virtual bool wantsMultiTouchEvents () const
virtual void findSingleTouchEventTarget (ITouchEvent::Touch &event)
virtual bool onDrop (IDataPackage *drag, const CPoint &where)
 called if a drag is dropped onto this view
virtual void onDragEnter (IDataPackage *drag, const CPoint &where)
 called if a drag is entering this view
virtual void onDragLeave (IDataPackage *drag, const CPoint &where)
 called if a drag is leaving this view
virtual void onDragMove (IDataPackage *drag, const CPoint &where)
 called if a drag is moved inside this view
virtual void looseFocus ()
 called if view should loose focus
virtual void takeFocus ()
 called if view should take focus
virtual bool isDirty () const
 check if view is dirty
virtual void parentSizeChanged ()
 notification that one of the views parent has changed its size
virtual bool sizeToFit ()
 resize view to optimal size
virtual bool removed (CView *parent)
virtual CPointframeToLocal (CPoint &point) const
 conversion from frame coordinates to local view coordinates
virtual CPointlocalToFrame (CPoint &point) const
 conversion from local view coordinates to frame coordinates
template<class ViewClass , class ContainerClass >
uint32_t getChildViewsOfType (ContainerClass &result, bool deep=false) const
CFrame Methods



virtual bool open (void *pSystemWindow, PlatformType systemWindowType=kDefaultNative)
virtual void close ()
 closes the frame and calls forget
virtual void idle ()
virtual uint32_t getTicks () const
 get the current time (in ms)
virtual int32_t getKnobMode () const
 get hosts knob mode
virtual bool setPosition (CCoord x, CCoord y)
virtual bool getPosition (CCoord &x, CCoord &y) const
virtual bool setSize (CCoord width, CCoord height)
virtual bool getSize (CRect *pSize) const
virtual bool getSize (CRect &pSize) const
virtual bool setModalView (CView *pView)
virtual CViewgetModalView () const
virtual void beginEdit (int32_t index)
virtual void endEdit (int32_t index)
virtual bool getCurrentMouseLocation (CPoint &where) const
 get current mouse location
virtual CButtonState getCurrentMouseButtons () const
 get current mouse buttons and key modifiers
virtual void setCursor (CCursorType type)
 set mouse cursor
virtual void setFocusView (CView *pView)
virtual CViewgetFocusView () const
virtual bool advanceNextFocusView (CView *oldFocus, bool reverse=false)
virtual void onViewAdded (CView *pView)
virtual void onViewRemoved (CView *pView)
virtual void onActivate (bool state)
 called when the platform view/window is activated/deactivated
 VSTGUI_DEPRECATED (CDrawContext *createDrawContext();) virtual void invalidate(const CRect &rect)
void scrollRect (const CRect &src, const CPoint &distance)
 scroll src rect by distance
void enableTooltips (bool state)
 enable or disable tooltips
Animation::AnimatorgetAnimator ()
 get animator for this frame
IDataPackagegetClipboard ()
 get the clipboard data. data is owned by the caller
void setClipboard (IDataPackage *data)
 set the clipboard data.
virtual IViewAddedRemovedObservergetViewAddedRemovedObserver () const
virtual void setViewAddedRemovedObserver (IViewAddedRemovedObserver *observer)
void registerKeyboardHook (IKeyboardHook *hook)
 register a keyboard hook
void unregisterKeyboardHook (IKeyboardHook *hook)
 unregister a keyboard hook
void registerMouseObserver (IMouseObserver *observer)
 register a mouse observer
void unregisterMouseObserver (IMouseObserver *observer)
 unregister a mouse observer
Focus Drawing Methods [new in 4.0]

If focus drawing is enabled, the focus view will get a focus ring around it defined with the focus width and the focus color. Views can define their own shape with the IFocusDrawing interface.



virtual void setFocusDrawingEnabled (bool state)
 enable focus drawing
virtual bool focusDrawingEnabled () const
 is focus drawing enabled
virtual void setFocusColor (const CColor &color)
 set focus draw color
virtual CColor getFocusColor () const
 get focus draw color
virtual void setFocusWidth (CCoord width)
 set focus draw width
virtual CCoord getFocusWidth () const
 get focus draw width
Sub View Methods



virtual bool addView (CView *pView)
 add a child view
virtual bool addView (CView *pView, const CRect &mouseableArea, bool mouseEnabled=true)
 add a child view
virtual bool addView (CView *pView, CView *pBefore)
 add a child view before another view
virtual bool isChild (CView *pView) const
 check if pView is a child view of this container
virtual bool isChild (CView *pView, bool deep) const
 check if pView is a child view of this container
virtual bool hasChildren () const
 check if container has child views
virtual int32_t getNbViews () const
 get the number of child views
virtual CViewgetView (int32_t index) const
 get the child view at index
virtual bool getViewsAt (const CPoint &where, std::list< SharedPointer< CView > > &views, bool deep=true) const
 get all views at point where, top->down
virtual bool changeViewZOrder (CView *view, int32_t newIndex)
 change view z order position
virtual void setAutosizingEnabled (bool state)
 enable or disable autosizing subviews. Per default this is enabled.
bool getAutosizingEnabled () const
Background Methods



virtual void setBackgroundColor (const CColor &color)
 set the background color (will only be drawn if this container is not set to transparent and does not have a background bitmap)
virtual CColor getBackgroundColor () const
 get the background color
virtual void setBackgroundOffset (const CPoint &p)
 set the offset of the background bitmap
virtual const CPointgetBackgroundOffset () const
 get the offset of the background bitmap
virtual void drawBackgroundRect (CDrawContext *pContext, const CRect &_updateRect)
 draw the background
virtual void setBackgroundColorDrawStyle (CDrawStyle style)
CDrawStyle getBackgroundColorDrawStyle () const
Message Methods



virtual CMessageResult notify (CBaseObject *sender, IdStringPtr message)
Attaching Methods



virtual bool removed (CView *parent)
 view is removed from parent view
virtual bool attached (CView *parent)
 view is attached to a parent view
bool isAttached () const
 is view attached to a parentView
Mouse Methods



virtual CMouseEventResult onMouseEntered (CPoint &where, const CButtonState &buttons)
 called when the mouse enters this view
void setHitTestPath (CGraphicsPath *path)
virtual void setMouseEnabled (bool bEnable=true)
 turn on/off mouse usage for this view
virtual bool getMouseEnabled () const
 get the state of wheather this view uses the mouse or not
virtual void setMouseableArea (const CRect &rect)
 set the area in which the view reacts to the mouse
virtual CRectgetMouseableArea (CRect &rect) const
 get the area in which the view reacts to the mouse
virtual const CRectgetMouseableArea () const
 read only access to the mouseable area
View Size Methods



CCoord getHeight () const
 get the height of the view
CCoord getWidth () const
 get the width of the view
CRectgetViewSize (CRect &rect) const
 returns the current view size
const CRectgetViewSize () const
 read only access to view size
virtual CRect getVisibleViewSize () const
 returns the visible size of the view
virtual void setAutosizeFlags (int32_t flags)
 set autosize flags
virtual int32_t getAutosizeFlags () const
 get autosize flags
Focus Methods



virtual bool wantsFocus () const
 check if view supports focus
virtual void setWantsFocus (bool state)
 set focus support on/off
Attribute Methods



bool getAttributeSize (const CViewAttributeID id, int32_t &outSize) const
 get the size of an attribute
bool getAttribute (const CViewAttributeID id, const int32_t inSize, void *outData, int32_t &outSize) const
 get an attribute
bool setAttribute (const CViewAttributeID id, const int32_t inSize, const void *inData)
 set an attribute
bool removeAttribute (const CViewAttributeID id)
 remove an attribute
Background Methods



virtual void setBackground (CBitmap *background)
 set the background image of this view
CBitmapgetBackground () const
 get the background image of this view
virtual void setDisabledBackground (CBitmap *background)
 set background image used when the mouse is not enabled
CBitmapgetDisabledBackground () const
 get background image used when the mouse is not enabled
CBitmapgetDrawBackground () const
Transparency Methods



virtual void setTransparency (bool val)
 set views transparent state
virtual bool getTransparency () const
 get views transparent state
virtual void setAlphaValue (float alpha)
 set alpha value which will be applied when drawing this view
float getAlphaValue () const
 get alpha value
Parent Methods



CViewgetParentView () const
 get parent view
CFramegetFrame () const
 get frame
Animation Methods



void addAnimation (IdStringPtr name, Animation::IAnimationTarget *target, Animation::ITimingFunction *timingFunction, CBaseObject *notificationObject=0)
void removeAnimation (IdStringPtr name)
void removeAllAnimations ()
Reference Counting Methods



virtual void forget ()
 decrease refcount and delete object if refcount == 0
virtual void remember ()
 increase refcount
virtual int32_t getNbReference () const
 get refcount

Public Attributes

VSTGUIEditorInterfacepEditor

Protected Types

typedef std::list< CView * > ViewList
enum  { kAutosizeSubviews = 1 << (CView::kLastCViewFlag + 1) }
enum  {
  kMouseEnabled = 1 << 0, kTransparencyEnabled = 1 << 1, kWantsFocus = 1 << 2, kIsAttached = 1 << 3,
  kVisible = 1 << 4, kDirty = 1 << 5, kWantsIdle = 1 << 6, kLastCViewFlag = 6
}

Protected Member Functions

 ~CFrame ()
void checkMouseViews (const CPoint &where, const CButtonState &buttons)
void clearMouseViews (const CPoint &where, const CButtonState &buttons, bool callMouseExit=true)
void removeFromMouseViews (CView *view)
int32_t keyboardHooksOnKeyDown (const VstKeyCode &key)
int32_t keyboardHooksOnKeyUp (const VstKeyCode &key)
void callMouseObserverMouseEntered (CView *view)
void callMouseObserverMouseExited (CView *view)
CMouseEventResult callMouseObserverMouseDown (const CPoint &where, const CButtonState &buttons)
CMouseEventResult callMouseObserverMouseMoved (const CPoint &where, const CButtonState &buttons)
bool platformDrawRect (CDrawContext *context, const CRect &rect)
CMouseEventResult platformOnMouseDown (CPoint &where, const CButtonState &buttons)
CMouseEventResult platformOnMouseMoved (CPoint &where, const CButtonState &buttons)
CMouseEventResult platformOnMouseUp (CPoint &where, const CButtonState &buttons)
CMouseEventResult platformOnMouseExited (CPoint &where, const CButtonState &buttons)
bool platformOnMouseWheel (const CPoint &where, const CMouseWheelAxis &axis, const float &distance, const CButtonState &buttons)
bool platformOnDrop (IDataPackage *drag, const CPoint &where)
void platformOnDragEnter (IDataPackage *drag, const CPoint &where)
void platformOnDragLeave (IDataPackage *drag, const CPoint &where)
void platformOnDragMove (IDataPackage *drag, const CPoint &where)
bool platformOnKeyDown (VstKeyCode &keyCode)
bool platformOnKeyUp (VstKeyCode &keyCode)
void platformOnActivate (bool state)
void platformOnTouchEvent (ITouchEvent &event)
virtual bool checkUpdateRect (CView *view, const CRect &rect)
virtual bool hitTestSubViews (const CPoint &where, const CButtonState buttons=-1)
CGraphicsPathgetHitTestPath () const

Protected Attributes

IViewAddedRemovedObserverpViewAddedRemovedObserver
CTooltipSupportpTooltips
Animation::AnimatorpAnimator
CViewpModalView
CViewpFocusView
CViewpActiveFocusView
ViewList pMouseViews
bool bActive
std::list< IKeyboardHook * > * pKeyboardHooks
std::list< IMouseObserver * > * pMouseObservers
IPlatformFrame * platformFrame
CDrawStyle backgroundColorDrawStyle
CColor backgroundColor
CPoint backgroundOffset
CRect lastDrawnFocus
CViewcurrentDragView
CViewmouseDownView
CRect size
CRect mouseableArea
CFramepParentFrame
CViewpParentView
int32_t viewFlags
int32_t autosizeFlags
float alphaValue

Draw and Update Methods



virtual bool checkUpdate (const CRect &updateRect) const
virtual void setDirty (bool val=true)
 set the view to dirty so that it is redrawn in the next idle. Thread Safe !
virtual void setVisible (bool state)
 set visibility state
bool isVisible () const
 get visibility state
static bool kDirtyCallAlwaysOnMainThread = false
 if this is true, setting a view dirty will call invalid() instead of checking it in idle. Default value is false.

Idle Methods

Should be used when a view needs to do a task periodically. The onIdle() method will be called only if the view is attached.



virtual void onIdle ()
 called on idle when view wants idle
void setWantsIdle (bool state)
 enable/disable onIdle() callback
bool wantsIdle () const
 returns if the view wants idle callback or not
static int32_t idleRate
 global idle rate in Hz, defaults to 30 Hz

Detailed Description

The CFrame is the parent container of all views.

It creates a platform dependend view object.

On Mac OS X it is a HIView or NSView.
On Windows it's a WS_CHILD Window.


Member Typedef Documentation

typedef std::list<SharedPointer<CView> >::const_iterator ChildViewConstIterator [inherited]
typedef std::list<SharedPointer<CView> >::const_reverse_iterator ChildViewConstReverseIterator [inherited]
typedef std::list<CView*> ViewList [protected]

Member Enumeration Documentation

anonymous enum [protected, inherited]
Enumerator:
kMouseEnabled 
kTransparencyEnabled 
kWantsFocus 
kIsAttached 
kVisible 
kDirty 
kWantsIdle 
kLastCViewFlag 
anonymous enum [protected, inherited]
Enumerator:
kAutosizeSubviews 
enum DragResult [inherited]
Enumerator:
kDragRefused 
kDragMoved 
kDragCopied 
kDragError 

Constructor & Destructor Documentation

~CFrame (  )  [protected]

Member Function Documentation

void addAnimation ( IdStringPtr  name,
Animation::IAnimationTarget target,
Animation::ITimingFunction timingFunction,
CBaseObject notificationObject = 0 
) [inherited]
virtual bool addView ( CView pView,
CView pBefore 
) [virtual, inherited]

add a child view before another view

Reimplemented in CAutoLayoutContainerView, CScrollView, CShadowViewContainer, and CSplitView.

virtual bool addView ( CView pView,
const CRect mouseableArea,
bool  mouseEnabled = true 
) [virtual, inherited]

add a child view

Reimplemented in CAutoLayoutContainerView, CScrollView, CShadowViewContainer, and CSplitView.

virtual bool addView ( CView pView  )  [virtual, inherited]

add a child view

Reimplemented in CAutoLayoutContainerView, CScrollView, CShadowViewContainer, and CSplitView.

bool advanceNextFocusView ( CView oldFocus,
bool  reverse = false 
) [virtual]

Reimplemented from CViewContainer.

bool attached ( CView parent  )  [virtual, inherited]

view is attached to a parent view

Parameters:
parent parent view
Returns:
true if view successfully attached to parent
bool attached ( CView parent  )  [virtual]

Reimplemented from CViewContainer.

void beginEdit ( int32_t  index  )  [virtual]
CMouseEventResult callMouseObserverMouseDown ( const CPoint where,
const CButtonState buttons 
) [protected]
void callMouseObserverMouseEntered ( CView view  )  [protected]
void callMouseObserverMouseExited ( CView view  )  [protected]
CMouseEventResult callMouseObserverMouseMoved ( const CPoint where,
const CButtonState buttons 
) [protected]
virtual bool changeViewZOrder ( CView view,
int32_t  newIndex 
) [virtual, inherited]

change view z order position

Reimplemented in CAutoLayoutContainerView, and CShadowViewContainer.

void checkMouseViews ( const CPoint where,
const CButtonState buttons 
) [protected]
virtual bool checkUpdate ( const CRect updateRect  )  const [inline, virtual, inherited]
virtual bool checkUpdateRect ( CView view,
const CRect rect 
) [protected, virtual, inherited]
void clearMouseViews ( const CPoint where,
const CButtonState buttons,
bool  callMouseExit = true 
) [protected]
void close (  )  [virtual]

closes the frame and calls forget

CView::DragResult doDrag ( IDataPackage source,
const CPoint offset,
CBitmap dragBitmap 
) [virtual]

start a drag operation. See CDropSource to create the source data package

a drag can only be started from within onMouseDown

Parameters:
source source drop
offset bitmap offset
dragBitmap bitmap to drag
Returns:
0 on failure, negative if source was moved and positive if source was copied

Reimplemented from CView.

void draw ( CDrawContext pContext  )  [virtual]

called if the view should draw itself

Parameters:
pContext draw context in which to draw

Reimplemented from CViewContainer.

virtual void drawBackgroundRect ( CDrawContext pContext,
const CRect _updateRect 
) [virtual, inherited]

draw the background

Reimplemented in CScrollView, CShadowViewContainer, and CTabView.

void drawRect ( CDrawContext pContext,
const CRect updateRect 
) [virtual]

called if the view should draw itself

Reimplemented from CViewContainer.

void enableTooltips ( bool  state  ) 

enable or disable tooltips

void endEdit ( int32_t  index  )  [virtual]
virtual void findSingleTouchEventTarget ( ITouchEvent::Touch event  )  [virtual, inherited]
bool focusDrawingEnabled (  )  const [virtual]

is focus drawing enabled

virtual void forget (  )  [inline, virtual, inherited]

decrease refcount and delete object if refcount == 0

virtual CPoint& frameToLocal ( CPoint point  )  const [virtual, inherited]

conversion from frame coordinates to local view coordinates

Parameters:
point location
Returns:
converted point

Reimplemented from CView.

float getAlphaValue (  )  const [inline, inherited]

get alpha value

Animation::Animator * getAnimator (  ) 

get animator for this frame

bool getAttribute ( const CViewAttributeID  aId,
const int32_t  inSize,
void *  outData,
int32_t &  outSize 
) const [inherited]

get an attribute

Parameters:
aId the ID of the Attribute
inSize the size of the outData pointer
outData a pointer where to copy the attribute data
outSize the size in bytes which was copied into outData
Returns:
true if attribute exists and outData was big enough. outSize and outData is valid then.
bool getAttributeSize ( const CViewAttributeID  aId,
int32_t &  outSize 
) const [inherited]

get the size of an attribute

Parameters:
aId the ID of the Attribute
outSize on return the size of the attribute
Returns:
true if attribute exists. outSize is valid then.
virtual int32_t getAutosizeFlags (  )  const [inline, virtual, inherited]

get autosize flags

bool getAutosizingEnabled (  )  const [inline, inherited]
CBitmap* getBackground (  )  const [inline, inherited]

get the background image of this view

virtual CColor getBackgroundColor (  )  const [inline, virtual, inherited]

get the background color

CDrawStyle getBackgroundColorDrawStyle (  )  const [inline, inherited]
virtual const CPoint& getBackgroundOffset (  )  const [inline, virtual, inherited]

get the offset of the background bitmap

uint32_t getChildViewsOfType ( ContainerClass &  result,
bool  deep = false 
) const [inline, inherited]

get child views of type ViewClass. ContainerClass must be a stdc++ container

IDataPackage * getClipboard (  ) 

get the clipboard data. data is owned by the caller

CViewContainer * getContainerAt ( const CPoint where,
bool  deep = true 
) const [virtual]

get the container at point where

Reimplemented from CViewContainer.

CButtonState getCurrentMouseButtons (  )  const [virtual]

get current mouse buttons and key modifiers

Returns:
mouse and modifier state
bool getCurrentMouseLocation ( CPoint where  )  const [virtual]

get current mouse location

Parameters:
where location of mouse
Returns:
true on success
CBitmap* getDisabledBackground (  )  const [inline, inherited]

get background image used when the mouse is not enabled

CBitmap* getDrawBackground (  )  const [inline, inherited]
virtual VSTGUIEditorInterface* getEditor (  )  const [inline, virtual]

get editor

Reimplemented from CView.

CColor getFocusColor (  )  const [virtual]

get focus draw color

virtual CView* getFocusView (  )  const [inline, virtual]
CCoord getFocusWidth (  )  const [virtual]

get focus draw width

CFrame* getFrame (  )  const [inline, inherited]

get frame

CCoord getHeight (  )  const [inline, inherited]

get the height of the view

CGraphicsPath* getHitTestPath (  )  const [inline, protected, inherited]
int32_t getKnobMode (  )  const [virtual]

get hosts knob mode

virtual CView* getModalView (  )  const [inline, virtual]
virtual const CRect& getMouseableArea (  )  const [inline, virtual, inherited]

read only access to the mouseable area

virtual CRect& getMouseableArea ( CRect rect  )  const [inline, virtual, inherited]

get the area in which the view reacts to the mouse

virtual bool getMouseEnabled (  )  const [inline, virtual, inherited]

get the state of wheather this view uses the mouse or not

virtual int32_t getNbReference (  )  const [inline, virtual, inherited]

get refcount

virtual int32_t getNbViews (  )  const [virtual, inherited]

get the number of child views

Reimplemented in CScrollView.

CView* getParentView (  )  const [inline, inherited]

get parent view

IPlatformFrame* getPlatformFrame (  )  const [inline]
bool getPosition ( CCoord x,
CCoord y 
) const [virtual]

get global position of frame

Parameters:
x x coordinate
y y coordinate
Returns:
true on success
bool getSize ( CRect pSize  )  const [virtual]
bool getSize ( CRect pRect  )  const [virtual]

get size relative to parent

Parameters:
pRect size
Returns:
true on success
uint32_t getTicks (  )  const [virtual]

get the current time (in ms)

Returns:
tick count in milliseconds
virtual bool getTransparency (  )  const [inline, virtual, inherited]

get views transparent state

virtual CView* getView ( int32_t  index  )  const [virtual, inherited]

get the child view at index

Reimplemented in CScrollView.

virtual IViewAddedRemovedObserver* getViewAddedRemovedObserver (  )  const [inline, virtual]
CView * getViewAt ( const CPoint where,
bool  deep = false,
bool  mustbeMouseEnabled = false 
) const [virtual]

get the view at point where

Reimplemented from CViewContainer.

virtual bool getViewsAt ( const CPoint where,
std::list< SharedPointer< CView > > &  views,
bool  deep = true 
) const [virtual, inherited]

get all views at point where, top->down

const CRect& getViewSize (  )  const [inline, inherited]

read only access to view size

CRect& getViewSize ( CRect rect  )  const [inline, inherited]

returns the current view size

virtual CRect getVisibleSize ( const CRect rect  )  const [virtual, inherited]
CRect getVisibleViewSize (  )  const [virtual, inherited]

returns the visible size of the view

Returns:
visible size of view
CCoord getWidth (  )  const [inline, inherited]

get the width of the view

virtual bool hasChildren (  )  const [virtual, inherited]

check if container has child views

virtual bool hitTest ( const CPoint where,
const CButtonState buttons = -1 
) [virtual, inherited]

check if where hits this view

Parameters:
where location
buttons button and modifier state
Returns:
true if point hits this view

Reimplemented from CView.

virtual bool hitTestSubViews ( const CPoint where,
const CButtonState  buttons = -1 
) [protected, virtual, inherited]
void idle (  )  [virtual]
void invalid (  )  [inline, virtual]

mark whole view as invalid

Reimplemented from CViewContainer.

virtual bool invalidateDirtyViews (  )  [virtual, inherited]
void invalidRect ( const CRect rect  )  [virtual]

mark rect as invalid

Parameters:
rect rect to invalidate

Reimplemented from CViewContainer.

bool isAttached (  )  const [inline, inherited]

is view attached to a parentView

virtual bool isChild ( CView pView,
bool  deep 
) const [virtual, inherited]

check if pView is a child view of this container

virtual bool isChild ( CView pView  )  const [virtual, inherited]

check if pView is a child view of this container

virtual bool isDirty (  )  const [virtual, inherited]

check if view is dirty

Reimplemented from CView.

bool isVisible (  )  const [inline, inherited]

get visibility state

int32_t keyboardHooksOnKeyDown ( const VstKeyCode key  )  [protected]
int32_t keyboardHooksOnKeyUp ( const VstKeyCode key  )  [protected]
virtual CPoint& localToFrame ( CPoint point  )  const [virtual, inherited]

conversion from local view coordinates to frame coordinates

Parameters:
point location
Returns:
converted point

Reimplemented from CView.

virtual void looseFocus (  )  [virtual, inherited]

called if view should loose focus

Reimplemented from CView.

void modifyDrawContext ( CCoord  save[4],
CDrawContext pContext 
) [inherited]
virtual CMessageResult notify ( CBaseObject sender,
IdStringPtr  message 
) [inline, virtual, inherited]
virtual CMessageResult notify ( CBaseObject sender,
IdStringPtr  message 
) [virtual, inherited]
Parameters:
sender message sender
message message text
Returns:
message handled or not. See CMessageResult

Reimplemented from CView.

Reimplemented in CDataBrowser, CRowColumnView, CScrollView, and CShadowViewContainer.

void onActivate ( bool  state  )  [virtual]

called when the platform view/window is activated/deactivated

virtual void onDragEnter ( IDataPackage drag,
const CPoint where 
) [virtual, inherited]

called if a drag is entering this view

Reimplemented from CView.

virtual void onDragLeave ( IDataPackage drag,
const CPoint where 
) [virtual, inherited]

called if a drag is leaving this view

Reimplemented from CView.

virtual void onDragMove ( IDataPackage drag,
const CPoint where 
) [virtual, inherited]

called if a drag is moved inside this view

Reimplemented from CView.

virtual bool onDrop ( IDataPackage drag,
const CPoint where 
) [virtual, inherited]

called if a drag is dropped onto this view

Reimplemented from CView.

virtual void onIdle (  )  [inline, virtual, inherited]

called on idle when view wants idle

Reimplemented in CVuMeter.

int32_t onKeyDown ( VstKeyCode keyCode  )  [virtual]

called if a key down event occurs and this view has focus

Parameters:
keyCode key code of pressed key
Returns:
-1 if not handled and 1 if handled

Reimplemented from CView.

int32_t onKeyUp ( VstKeyCode keyCode  )  [virtual]

called if a key up event occurs and this view has focus

Parameters:
keyCode key code of pressed key
Returns:
-1 if not handled and 1 if handled

Reimplemented from CView.

virtual CMouseEventResult onMouseCancel (  )  [virtual, inherited]

called when mouse tracking should be canceled

Reimplemented from CView.

CMouseEventResult onMouseDown ( CPoint where,
const CButtonState buttons 
) [virtual]

called when a mouse down event occurs

Parameters:
where mouse location of mouse down
buttons button and modifier state
Returns:
event result. see CMouseEventResult

Reimplemented from CViewContainer.

virtual CMouseEventResult onMouseEntered ( CPoint where,
const CButtonState buttons 
) [inline, virtual, inherited]

called when the mouse enters this view

Reimplemented in CScrollbar.

CMouseEventResult onMouseExited ( CPoint where,
const CButtonState buttons 
) [virtual]

called when the mouse leaves this view

Reimplemented from CView.

CMouseEventResult onMouseMoved ( CPoint where,
const CButtonState buttons 
) [virtual]

called when a mouse move event occurs

Parameters:
where mouse location of mouse move
buttons button and modifier state
Returns:
event result. see CMouseEventResult

Reimplemented from CViewContainer.

CMouseEventResult onMouseUp ( CPoint where,
const CButtonState buttons 
) [virtual]

called when a mouse up event occurs

Parameters:
where mouse location of mouse up
buttons button and modifier state
Returns:
event result. see CMouseEventResult

Reimplemented from CViewContainer.

virtual void onTouchEvent ( ITouchEvent event  )  [virtual, inherited]

Reimplemented from CView.

void onViewAdded ( CView pView  )  [virtual]
Parameters:
pView view which was added
void onViewRemoved ( CView pView  )  [virtual]
Parameters:
pView view which was removed
bool onWheel ( const CPoint where,
const CMouseWheelAxis axis,
const float &  distance,
const CButtonState buttons 
) [virtual]

called if a mouse wheel event is happening over this view

Parameters:
where location
axis mouse wheel axis
distance wheel distance
buttons button and modifier state
Returns:
true if handled

Reimplemented from CViewContainer.

bool onWheel ( const CPoint where,
const float &  distance,
const CButtonState buttons 
) [virtual]

called if a mouse wheel event is happening over this view

Parameters:
where location
distance wheel distance
buttons button and modifier state
Returns:
true if handled

Reimplemented from CViewContainer.

bool open ( void *  pSystemWindow,
PlatformType  systemWindowType = kDefaultNative 
) [virtual]
virtual void parentSizeChanged (  )  [virtual, inherited]

notification that one of the views parent has changed its size

Reimplemented from CView.

Reimplemented in CLayeredViewContainer.

bool platformDrawRect ( CDrawContext context,
const CRect rect 
) [protected]
void platformOnActivate ( bool  state  )  [protected]
void platformOnDragEnter ( IDataPackage drag,
const CPoint where 
) [protected]
void platformOnDragLeave ( IDataPackage drag,
const CPoint where 
) [protected]
void platformOnDragMove ( IDataPackage drag,
const CPoint where 
) [protected]
bool platformOnDrop ( IDataPackage drag,
const CPoint where 
) [protected]
bool platformOnKeyDown ( VstKeyCode keyCode  )  [protected]
bool platformOnKeyUp ( VstKeyCode keyCode  )  [protected]
CMouseEventResult platformOnMouseDown ( CPoint where,
const CButtonState buttons 
) [protected]
CMouseEventResult platformOnMouseExited ( CPoint where,
const CButtonState buttons 
) [protected]
CMouseEventResult platformOnMouseMoved ( CPoint where,
const CButtonState buttons 
) [protected]
CMouseEventResult platformOnMouseUp ( CPoint where,
const CButtonState buttons 
) [protected]
bool platformOnMouseWheel ( const CPoint where,
const CMouseWheelAxis axis,
const float &  distance,
const CButtonState buttons 
) [protected]
void platformOnTouchEvent ( ITouchEvent event  )  [protected]
void registerKeyboardHook ( IKeyboardHook hook  ) 

register a keyboard hook

void registerMouseObserver ( IMouseObserver observer  ) 

register a mouse observer

virtual void remember (  )  [inline, virtual, inherited]

increase refcount

bool removeAll ( bool  withForget = true  )  [virtual]

remove all child views

Reimplemented from CViewContainer.

void removeAllAnimations (  )  [inherited]
void removeAnimation ( IdStringPtr  name  )  [inherited]
bool removeAttribute ( const CViewAttributeID  id  )  [inherited]

remove an attribute

bool removed ( CView parent  )  [virtual, inherited]

view is removed from parent view

Parameters:
parent parent view
Returns:
true if view successfully removed from parent
virtual bool removed ( CView parent  )  [virtual, inherited]
void removeFromMouseViews ( CView view  )  [protected]
bool removeView ( CView pView,
bool  withForget = true 
) [virtual]

remove a child view

Reimplemented from CViewContainer.

void restoreDrawContext ( CDrawContext pContext,
CCoord  save[4] 
) [inherited]
void scrollRect ( const CRect src,
const CPoint distance 
)

scroll src rect by distance

Parameters:
src rect which to scroll
distance point of distance
void setAlphaValue ( float  alpha  )  [virtual, inherited]

set alpha value which will be applied when drawing this view

bool setAttribute ( const CViewAttributeID  aId,
const int32_t  inSize,
const void *  inData 
) [inherited]

set an attribute

copies data into the attribute. If it does not exist, creates a new attribute.

Parameters:
aId the ID of the Attribute
inSize the size of the outData pointer
inData a pointer to the data
Returns:
true if attribute was set
virtual void setAutosizeFlags ( int32_t  flags  )  [inline, virtual, inherited]

set autosize flags

Reimplemented in CScrollView, and CTabView.

virtual void setAutosizingEnabled ( bool  state  )  [virtual, inherited]

enable or disable autosizing subviews. Per default this is enabled.

void setBackground ( CBitmap background  )  [virtual, inherited]

set the background image of this view

Parameters:
background new background bitmap

Reimplemented in CCheckBox, and CAnimKnob.

virtual void setBackgroundColor ( const CColor color  )  [virtual, inherited]

set the background color (will only be drawn if this container is not set to transparent and does not have a background bitmap)

Reimplemented in CScrollView.

virtual void setBackgroundColorDrawStyle ( CDrawStyle  style  )  [virtual, inherited]
virtual void setBackgroundOffset ( const CPoint p  )  [inline, virtual, inherited]

set the offset of the background bitmap

void setClipboard ( IDataPackage data  ) 

set the clipboard data.

void setCursor ( CCursorType  type  )  [virtual]

set mouse cursor

Parameters:
type cursor type see CCursorType
void setDirty ( bool  val = true  )  [virtual, inherited]

set the view to dirty so that it is redrawn in the next idle. Thread Safe !

Reimplemented in CControl, and CVuMeter.

void setDisabledBackground ( CBitmap background  )  [virtual, inherited]

set background image used when the mouse is not enabled

Parameters:
background new disabled background bitmap
void setFocusColor ( const CColor color  )  [virtual]

set focus draw color

void setFocusDrawingEnabled ( bool  state  )  [virtual]

enable focus drawing

void setFocusView ( CView pView  )  [virtual]
Parameters:
pView new focus view
void setFocusWidth ( CCoord  width  )  [virtual]

set focus draw width

void setHitTestPath ( CGraphicsPath path  )  [inherited]
Parameters:
path the path to use for hit testing. The path will be translated by this views origin, so that the path must not be set again, if the view is moved. Otherwise when the size of the view changes, the path must also be set again.
bool setModalView ( CView pView  )  [virtual]
Parameters:
pView the view which should be set to modal.
Returns:
true if view could be set as the modal view. false if there is a already a modal view or the view to be set as modal is already attached.
virtual void setMouseableArea ( const CRect rect  )  [inline, virtual, inherited]

set the area in which the view reacts to the mouse

void setMouseEnabled ( bool  bEnable = true  )  [virtual, inherited]

turn on/off mouse usage for this view

bool setPosition ( CCoord  x,
CCoord  y 
) [virtual]

repositions the frame

Parameters:
x x coordinate
y y coordinate
Returns:
true on success
bool setSize ( CCoord  width,
CCoord  height 
) [virtual]

set size of frame (and the platform representation)

Parameters:
width new width
height new height
Returns:
true on success
void setTransparency ( bool  val  )  [virtual, inherited]

set views transparent state

Reimplemented in CScrollView.

virtual void setViewAddedRemovedObserver ( IViewAddedRemovedObserver observer  )  [inline, virtual]
void setViewSize ( const CRect newSize,
bool  invalid = true 
) [virtual]

set views size

Parameters:
newSize rect of new size of view
invalid if true set view dirty

Reimplemented from CViewContainer.

void setVisible ( bool  state  )  [virtual, inherited]

set visibility state

Reimplemented in COpenGLView.

void setWantsFocus ( bool  state  )  [virtual, inherited]

set focus support on/off

Reimplemented in CDataBrowser.

void setWantsIdle ( bool  state  )  [inherited]

enable/disable onIdle() callback

virtual bool sizeToFit (  )  [virtual, inherited]

resize view to optimal size

Reimplemented from CView.

Reimplemented in CRowColumnView, and CSplitView.

virtual void takeFocus (  )  [virtual, inherited]

called if view should take focus

Reimplemented from CView.

void unregisterKeyboardHook ( IKeyboardHook hook  ) 

unregister a keyboard hook

void unregisterMouseObserver ( IMouseObserver observer  ) 

unregister a mouse observer

VSTGUI_DEPRECATED ( CDrawContext *createDrawContext();   )  const
VSTGUI_DEPRECATED ( CFrame(const CRect &size, void *pSystemWindow, VSTGUIEditorInterface *pEditor);   )  const
virtual bool wantsFocus (  )  const [inline, virtual, inherited]

check if view supports focus

bool wantsIdle (  )  const [inline, inherited]

returns if the view wants idle callback or not

virtual bool wantsMultiTouchEvents (  )  const [inline, virtual, inherited]

Reimplemented from CView.


Member Data Documentation

float alphaValue [protected, inherited]
int32_t autosizeFlags [protected, inherited]
CColor backgroundColor [protected, inherited]
CDrawStyle backgroundColorDrawStyle [protected, inherited]
CPoint backgroundOffset [protected, inherited]
bool bActive [protected]
CView* currentDragView [protected, inherited]
int32_t idleRate [static, inherited]

global idle rate in Hz, defaults to 30 Hz

bool kDirtyCallAlwaysOnMainThread = false [static, inherited]

if this is true, setting a view dirty will call invalid() instead of checking it in idle. Default value is false.

CRect lastDrawnFocus [protected, inherited]
CRect mouseableArea [protected, inherited]
CView* mouseDownView [protected, inherited]
CView* pActiveFocusView [protected]
CView* pFocusView [protected]
std::list<IKeyboardHook*>* pKeyboardHooks [protected]
IPlatformFrame* platformFrame [protected]
CView* pModalView [protected]
std::list<IMouseObserver*>* pMouseObservers [protected]
ViewList pMouseViews [protected]
CFrame* pParentFrame [protected, inherited]
CView* pParentView [protected, inherited]
CTooltipSupport* pTooltips [protected]
CRect size [protected, inherited]
int32_t viewFlags [protected, inherited]

The documentation for this class was generated from the following files:

Generated on Fri Nov 22 11:09:33 2013 for VSTGUI by  doxygen 1.6.1